.TH E1432_GET_OCTAVE_BLOCKSIZE 3 E1432
.SH NAME
.nf
e1432_get_octave_blocksize \- Get current Octave data blocksize
.IX e1432_get_octave_blocksize(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_get_octave_blocksize(E1432ID hw, SHORTSIZ16 ID,
                                      LONGSIZ32 *octave_blocksize)
.cE
.SH DESCRIPTION

\fIe1432_get_octave_blocksize\fR returns the current Octave data blocksize
of the modules(s) selected into a memory location pointed to
by \fIoctave_blocksize\fR.

This parameter is a "global" parameter.  It applies to an entire
module rather than to one of its channels.  The \fIID\fR parameter is
used only to identify which module the function applies to, and all
channels in that module will report the same value for this parameter.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained
with a call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.
It is used to determine which module(s) in \fIhw\fR to query.

Since the e1432_set_octave_start_freq and e1432_set_octave_stop_freq
functions change the number
of data points transferred by the e1432_read_XXXXXXX_data functions,
the \fIe1432_get_octave_blocksize\fR function has been provided to supply the
value needed for the \fIsize\fR parameter of the e1432_read_XXXXXXX_data
functions.

.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_octave_mode,
e1432_set_octave_avg_mode,
e1432_set_octave_hold_mode,
e1432_set_octave_start_freq, e1432_set_octave_stop_freq,
e1432_set_octave_int_time,
e1432_set_octave_time_const,
e1432_set_octave_time_step,
e1432_octave_ctl,
e1432_get_current_data
.ad
